---
title: gluestack-ui Menu Component | Installation, Usage, and API

description: Enhance usability with a dropdown interface for presenting options or actions, ensuring accessibility.

pageTitle: Menu

pageDescription: Enhance usability with a dropdown interface for presenting options or actions, ensuring accessibility.

showHeader: true
---

import { Meta } from '@storybook/addon-docs';

<Meta title="with-nativewind/Components/Overlay/Menu" />

import {
  Button,
  ButtonText,
  ButtonIcon,
  Menu,
  MenuIcon,
  MenuItem,
  MenuItemLabel,
  ThemeIcon,
  SettingsIcon,
  PlusIcon,
  Box,
  Badge,
  Pressable,
  Avatar,
  Divider,
  Text,
  Center,
  GlobeIcon,
  Icon,
  AddIcon,
  PlayIcon,
  HelpCircleIcon,
  MessageCircleIcon,
  BadgeText,
  MenuSeparator
} from '../../core-components/nativewind';
import { PaintBucket, PuzzleIcon } from 'lucide-react-native';
import { transformedCode } from '../../utils';
import {
  CodePreview,
  Table,
  TableContainer,
  InfoIcon,
  InlineCode,
  Tabs
} from '@gluestack/design-system';

import Wrapper from '../../core-components/nativewind/Wrapper';
import { CollapsibleCode } from '@gluestack/design-system';
import AnatomyImage from '../../extra-components/nativewind/AnatomyImage';

This is an illustration of a **Menu** component.

<Wrapper>
  <CodePreview
    showComponentRenderer={true}
    showArgsController={true}
    metaData={{
      code: `
      <Menu
        {...props}
        offset={5}
        disabledKeys={['Settings']}
        trigger={({ ...triggerProps }) => {
          return (
            <Button {...triggerProps}>
              <ButtonText>Menu</ButtonText>
            </Button>
          );
        }}
      >
        <MenuItem key="Add account" textValue="Add account">
          <Icon as={AddIcon} size="sm" className="mr-2" />
          <MenuItemLabel size="sm">Add account</MenuItemLabel>
        </MenuItem>
        <MenuItem key="Community" textValue="Community">
          <Icon as={GlobeIcon} size="sm" className="mr-2" />
          <MenuItemLabel size="sm">Community</MenuItemLabel>
        </MenuItem>
        <MenuItem key="Plugins" textValue="Plugins">
          <Icon as={PlayIcon} size="sm" className="mr-2" />
          <MenuItemLabel size="sm">Plugins</MenuItemLabel>
        </MenuItem>
        <MenuItem key="Settings" textValue="Settings">
          <Icon as={SettingsIcon} size="sm" className="mr-2" />
          <MenuItemLabel size="sm">Settings</MenuItemLabel>
        </MenuItem>
      </Menu>
      `,
      transformCode: (code) => {
        return transformedCode(code);
      },
      scope: {
        Wrapper,
        Button,
        ButtonText,
        Menu,
        MenuItem,
        MenuItemLabel,
        Icon,
        GlobeIcon,
        SettingsIcon,
        AddIcon,
        PlayIcon
      },
      argsType: {
        placement: {
          control: 'select',
          options: [
            'bottom',
            'bottom end',
            'bottom start',
            'top',
            'top end',
            'top start',
            'left',
            'left end',
            'left start',
            'right',
            'right end',
            'right start',
          ],
          default: 'top',
        },
      },
    }}
  />
</Wrapper>

<br />

## Installation

<Tabs value="cli" type="section">
<Tabs.TabList>
      <Tabs.Tab value="cli">
        <Tabs.TabTitle>CLI</Tabs.TabTitle>
      </Tabs.Tab>
     <Tabs.Tab value="manual">
        <Tabs.TabTitle>Manual</Tabs.TabTitle>
     </Tabs.Tab>
  </Tabs.TabList>
  <Tabs.TabPanels>
    <Tabs.TabPanel value="cli">
<>

### Run the following command:
  ```bash
  npx gluestack-ui add menu
  ```
</>
    </Tabs.TabPanel>
    <Tabs.TabPanel value="manual"> 
<>

### Step 1: Install the following dependencies:

```bash
npm i @gluestack-ui/menu @legendapp/motion
```
> Note: At present, we have integrated the `@legendapp/motion` for animation. You have the option to remove this and implement your own custom animation wrapper.

### Step 2: Copy and paste the following code into your project.

<CollapsibleCode>

```jsx 
%%-- File: core-components/nativewind/menu/index.tsx --%% 
```

</CollapsibleCode>

### Step 3: Update the import paths to match your project setup.
</>
    </Tabs.TabPanel>
  </Tabs.TabPanels>
</Tabs>

## API Reference

To use this component in your project, include the following import statement in your file.

```jsx
import {
  Menu,
  MenuItem,
  MenuItemLabel,
  MenuSeparator
} from '@/components/ui/menu';
```

<AnatomyImage mobileUrl='https://i.imgur.com/ychqRCR.png' webUrl='https://i.imgur.com/42xE2oh.png' classNameStyle='aspect-[513/477] md:aspect-[736/317]' />

```jsx
export default () => (
  <Menu>
    <MenuItem>
      <MenuItemLabel />
    </MenuItem>
    <MenuSeparator />
  </Menu>
);
```

### Component Props

This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.

#### Menu

Contains all menu related layout style props and actions.
It inherits all the properties of React Native's [View](https://reactnative.dev/docs/view) component.

<Wrapper>
  <TableContainer>
    <Table>
      <Table.THead>
        <Table.TR>
          <Table.TH>
            <Table.TText>Prop</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Type</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Default</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Description</Table.TText>
          </Table.TH>
        </Table.TR>
      </Table.THead>
      <Table.TBody>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>trigger</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>
              {'(_props: any, state: { open: boolean; }) => Element'}
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`Function that returns a React Element. This element will be used as a Trigger for the Menu`}</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>placement</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>
              {
                '"bottom" | "top" | "right" | "left" | "top left" | "top right" | "bottom left" | "bottom right" | "right top" | "right bottom" | "left top" | "left bottom"'
              }
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>bottom left</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>menu placement</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>defaultIsOpen</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>boolean</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>false</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`If true, the menu will be opened by default.`}</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>onOpen</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{'() => void'}</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>true</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`This function will be invoked when the menu is opened.`}</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>onClose</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{' () => void'}</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`This function will be invoked when menu is closed. It will also be called when the user attempts to close the menu via Escape key or backdrop press.`}</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>isOpen</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>boolean</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>false</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`Whether the menu is opened. Useful for controlling the open state.`}</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>offset</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>number</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>
              The additional offset applied along the main axis between the
              element and its trigger element.
            </Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>crossOffset</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>number</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>
              The additional offset applied along the cross axis between the
              element and its trigger element.
            </Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>disabledKeys</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>string []</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>
              Item keys in this collection will be disabled.
            </Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>closeOnSelect</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>boolean</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>true</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`This prop determine whether menu is closed after option is selected.`}</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>selectedKeys</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`'all' | Iterable<Key>`}</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`The currently selected keys in the collection (controlled).`}</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>selectionMode</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>'none'| 'single' | 'multiple'</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`The type of selection that is allowed in the collection.`}</Table.TText>
          </Table.TD>
        </Table.TR>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>onSelectionChange</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`(keys: 'all' | Iterable<Key>) => void`}</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`Handler that is called when the selection changes.`}</Table.TText>
          </Table.TD>
        </Table.TR>
      </Table.TBody>
    </Table>
  </TableContainer>
</Wrapper>

#### MenuItem

Contains all button related layout style props and actions. It inherits all the properties of React Native's [Pressable](https://reactnative.dev/docs/pressable) component.

<Wrapper>
  <TableContainer>
    <Table>
      <Table.THead>
        <Table.TR>
          <Table.TH>
            <Table.TText>Prop</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Type</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Default</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Description</Table.TText>
          </Table.TH>
        </Table.TR>
      </Table.THead>
      <Table.TBody>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>closeOnSelect</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>boolean</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>true</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`This prop determine whether menu is closed after option is selected.`}</Table.TText>
          </Table.TD>
        </Table.TR>
      </Table.TBody>
    </Table>
  </TableContainer>
</Wrapper>

#### MenuItemLabel

Contains all text related layout style props and actions. It inherits all the properties of React Native's [Text](https://reactnative.dev/docs/text) component.

#### MenuSeparator

Contains all view related layout style props and actions. It inherits all the properties of React Native's [View](https://reactnative.dev/docs/view) component.

### Features

- Keyboard support for actions.
- Support for hover, focus and active states.

### Accessibility

We have outlined the various features that ensure the Menu component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards. Adheres to the [MENU WAI-ARIA design pattern](https://www.w3.org/WAI/ARIA/apg/patterns/menubar/).

#### Keyboard

- `Space`: Opens/closes the menu.
- `Enter`: Opens/closes the menu.
- `Arrow Down`: Moves focus to the next focusable element.
- `Arrow Up`: Moves focus to the previous focusable element.
- `Esc`: Closes the menu and moves focus to menuTrigger.

#### Screen Reader

- VoiceOver: When the menu is opened, the screen reader will say, Menu item group with 4 items. You are currently on a menu item group. To select this menu item, press Control + Option + Space. To close the menu, press Escape.

#### States

- `aria-labelledby` identifies the element that labels the current element.
- `aria-label` defines a string value that labels the current element.

### Examples

The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project.

#### Menu with Tag

<Wrapper>
  <CodePreview
    showComponentRenderer={true}
    showArgsController={false}
    metaData={{
      code: `
      <Menu
        offset={5}
        trigger={({ ...triggerProps }) => {
          return (
            <Button {...triggerProps} size="sm">
              <ButtonIcon as={MenuIcon} />
            </Button>
          );
        }}
      >
        <MenuItem
          key="Membership"
          textValue="Membership"
          className="p-2 justify-between"
        >
          <MenuItemLabel size="sm">Membership</MenuItemLabel>
          <Badge action="success" className="rounded-full">
            <BadgeText className="text-2xs capitalize">Pro</BadgeText>
          </Badge>
        </MenuItem>
        <MenuItem key="Orders" textValue="Orders" className="p-2">
          <MenuItemLabel size="sm">Orders</MenuItemLabel>
        </MenuItem>
        <MenuItem
          key="Address Book"
          textValue="Address Book"
          className="p-2"
        >
          <MenuItemLabel size="sm">Address Book</MenuItemLabel>
        </MenuItem>
        <MenuSeparator />
        <MenuItem key="Earn & Redeem" textValue="Earn & Redeem" className="p-2">
          <MenuItemLabel size="sm">Earn & Redeem</MenuItemLabel>
        </MenuItem>
        <MenuItem key="Coupons" textValue="Coupons" className="p-2">
          <MenuItemLabel size="sm">Coupons</MenuItemLabel>
        </MenuItem>
        <MenuItem
          key="Help Center"
          textValue="Help Center"
          className="p-2"
        >
          <MenuItemLabel size="sm">Help Center</MenuItemLabel>
        </MenuItem>
         <MenuSeparator />
        <MenuItem key="Logout" textValue="Logout" className="p-2">
          <MenuItemLabel size="sm">Logout</MenuItemLabel>
        </MenuItem>
      </Menu>
      `,
      transformCode: (code) => {
        return transformedCode(code);
      },
      scope: {
        Wrapper,
        Button,
        ButtonIcon,
        MenuIcon,
        Menu,
        MenuItem,
        MenuItemLabel,
        MenuSeparator,
        Box,
        Text,
        Badge,
        BadgeText
      },
      argsType: {},
    }}
  />
</Wrapper>

#### Menu with Selection

<Wrapper>
  <CodePreview
    showComponentRenderer={true}
    showArgsController={false}
    metaData={{
      code: `
      function Example() {
        const [selected, setSelected] = React.useState(new Set([]));
        return (
          <Menu
            placement="bottom left"
            selectionMode="single"
            selectedKeys={selected}
            offset={5}
            className="p-1.5"
            onSelectionChange={(keys) => {
              // console.log('onSelectionChange', keys);
              setSelected(keys);
              if (keys.currentKey === 'Account Setting') {
                console.log('Push to', keys.currentKey, 'route');
              } else if (keys.currentKey === 'Help Centre') {
                console.log('Push to', keys.currentKey, 'route');
              } else if (keys.currentKey === 'Contact Support') {
                console.log('Push to', keys.currentKey, 'route');
              } else if (keys.currentKey === 'Download Mobile App') {
                console.log('Push to', keys.currentKey, 'route');
              } else if (keys.currentKey === 'Install Chrome Extension') {
                console.log('Push to', keys.currentKey, 'route');
              }
            }}
            closeOnSelect={true}
            trigger={({ ...triggerProps }) => {
              return (
                <Button {...triggerProps}>
                  <ButtonText>Menu</ButtonText>
                </Button>
              );
            }}
          >
            <MenuItem
              key="Account Settings"
              textValue="Account Settings"
              className="p-2 min-w-[294px]"
            >
              <Icon as={SettingsIcon} size="sm" className="mr-2" />
              <MenuItemLabel size="sm">Account Settings</MenuItemLabel>
            </MenuItem>
            <MenuItem key="Help Centre" textValue="Help Centre" className="p-2">
              <Icon as={HelpCircleIcon} size="sm" className="mr-2" />
              <MenuItemLabel size="sm">Help Centre</MenuItemLabel>
            </MenuItem>
            <MenuItem
              key="Contact Support"
              textValue="Contact Support"
              className="p-2"
            >
              <Icon as={MessageCircleIcon} size="sm" className="mr-2" />
              <MenuItemLabel size="sm">Contact Support</MenuItemLabel>
            </MenuItem>
            <MenuSeparator />
            <MenuItem
              key="Download Mobile App"
              textValue="Download Mobile App"
              className="p-2"
            >
              <MenuItemLabel size="sm">Download Mobile App</MenuItemLabel>
            </MenuItem>
            <MenuItem
              key="Install Chrome Extension"
              textValue="Install Chrome Extension"
              className="p-2"
            >
              <MenuItemLabel size="sm">Install Chrome Extension</MenuItemLabel>
            </MenuItem>
          </Menu>
        );
      }
      `,
      transformCode: (code) => {
        return transformedCode(code, 'function', 'Example');
      },
      scope: {
        Wrapper,
        Button,
        ButtonText,
        Menu,
        MenuItem,
        MenuItemLabel,
        Icon,
        SettingsIcon,
        HelpCircleIcon,
        MessageCircleIcon,
        MenuSeparator,
      },
      argsType: {},
    }}
  />
</Wrapper>